chore(docs): make typedoc resolve node Buffer type via tsconfig.docs.json - #458
Merged
Merged
Conversation
github-actions
Bot
added
the
t-tooling
barjin
changed the title
typedoc resolve node Buffer type via tsconfig.docs.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The docs build started failing on master after the TypeScript v6 upgrade (#425) with:
TS6 no longer accepts an unresolved
Bufferglobal. Thedocsscript ran typedoc without a tsconfig, so@types/node(already a devDependency) was not picked up.Adds a minimal
impit-node/tsconfig.docs.jsonthat pinstypes: ["node"]and scopes the program toindex.d.ts, and passes it to typedoc via--tsconfig. Verified locally — docs now generate without error.